Payments and Transfers
The Payments and Transfers API lets you make payments of various types and perform PIX, TED, and TEF transfers. This API also lets you cancel and list payments and transfers.
Use Cases
- Provide the ability to initiate payments within your system.
- Monitor payment statuses within a system.
- Manage payment batches.
How payments work
In the BTG Empresas API ecosystem, requests create "payment initiations". These initiations must be approved via internet banking or the mobile app by the necessary parties, respecting the company's signature rules and powers.
In other words, when you use the API, money is not moved instantly; it moves only after approval via the mobile app or internet banking.
Approvals can be made individually or in batch, as can the creation of individual or batch "payment initiations".
Payment and transfer types
The Payments and Transfers API offers a range of payment types, which differ only in the data sent in the request body within the details object and in the selected type.
PIX_QR_CODE
This type requires the emv — also called the copy-and-paste code — of the QR code to be provided within details. This type creates the initiation of a PIX payment or transfer.
BANKSLIP
This type requires the boleto's payment line digitableLine to be provided within details. It does not accept payment lines that start with 8.
UTILITIES
This type requires the payment line digitableLine or barcode barcode of the bill to be paid to be provided within details.
Bills eligible for the UTILITIES type are those whose identification code mentioned in the paragraph above starts with digit 8, such as DARFs, water/electricity bills, etc.
TED and PIX_MANUAL
This type requires the beneficiary account information of the payment or transaction to be provided within details. The type of payment or transfer depends on the type provided:
- PIX_MANUAL is a PIX
- TED is a TED or TEF based on what is provided.
PIX_KEY
This type requires a valid Pix key of any type to be provided within details. It originates a PIX payment or transfer.
DARF
This type requires the information of the document to be paid to be provided within details.
PIX_REVERSAL
This type requires the originalEndToEndId of the received Pix to be provided within details. This type is a refund of a received Pix to the account where the transaction originated.
Available Resources
The Payments and Transfers API resources are available in the API Reference.